package org.luxor.commons.lock4j.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 分布式锁注解
 *
 * @author zengzh
 * @since 1.0.0
 */
@Target(value = {ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Lock4j {

    /**
     * 锁的唯一标识Key (规则：包名+方法名+#{keys})
     */
    String[] keys() default "";

    /**
     * 锁的过期时间 (默认15分钟，单位：毫秒）
     * <pre>
     *     过期时间一定是要长于业务的执行时间.
     * </pre>
     */
    long expire() default 900000;

    /**
     * 获取锁超时时间 （默认3秒，单位：毫秒）
     * <pre>
     *     结合业务,建议该时间不宜设置过长,特别在并发高的情况下.
     * </pre>
     */
    long timeout() default 3000;

    /**
     * 获取锁失败，异常码
     */
    int errorCode() default 10101009;

    /**
     * 获取锁失败，异常信息
     */
    String errorMsg() default "获取分布式锁(Lock4j)失败.";

}
